AcquireAggregateClipShape

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODFacet

AcquireAggregateClipShape
The AcquireAggregateClipShape method calculates and returns a reference to a shape object that represents the aggregate clip shape of this facet.
ODShape AcquireAggregateClipShape (in ODCanvas biasCanvas);
biasCanvas
kODNULL if the geometry is in platform-normal coordinates, otherwise a reference to the canvas object to whose coordinate space the geometry is biased.
return value
A reference to a shape object that represents the aggregate clip shape.

DISCUSSION
The aggregate clip shape describes this facet's clip shape on its canvas. The aggregate clip shape is calculated by intersecting this facet's clip shape with the appropriately transformed clip shapes of all containing facets displayed on this facet's canvas.
This method increments the reference count of the returned shape object. When you have finished using that shape object, you should call its Release method.

SEE ALSO
The ODFacet::AcquireClipShape method (page 226).
The ODFacet::AcquireWindowAggregateClipShape method (page 229).
"The Draw Method of Your Part Editor" on page 158 in OpenDoc Programmer's Guide.